Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(x/accounts/defaults/lockup): Clean up some logic #20037

Merged
merged 33 commits into from
Apr 29, 2024

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Apr 14, 2024

Description

  • Some minor checks and changes
  • Add missing withdraw reward execute handler and test

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Added a new withdrawal feature for rewards in lockup accounts.
    • Enhanced account initialization to set initial values based on staking denominations.
  • Bug Fixes

    • Updated error messages for delegation and undelegation attempts to provide clearer explanations regarding zero coin staking or insufficient funds.
  • Refactor

    • Improved logic for handling coin entries and lockup information, ensuring more accurate processing based on block times.
    • Removed unused Undelegate methods to streamline lockup account operations.
  • Tests

    • Introduced new tests for delegation and reward withdrawal functionalities.
    • Adjusted test setups to better reflect operational contexts.
  • Documentation

    • Updated comments and documentation to reflect changes in lockup account operations and test configurations.
  • Chores

    • Updated project configuration settings to reflect new naming conventions.

Copy link
Contributor

coderabbitai bot commented Apr 14, 2024

Walkthrough

Walkthrough

The updates focus on enhancing the lockup module in the Cosmos SDK, introducing new functionalities and refining existing ones. Key changes include adding a new dependency, updating the BaseLockup struct, and refining methods to handle token delegation, withdrawal, and rewards more effectively. The integration of new message types and modifications in testing and utility functions support these enhancements. Additionally, updates in the SonarCloud configuration and test workflows are made to streamline development processes.

Changes

Files Change Summary
x/accounts/defaults/lockup/... Introduced new dependency and updated BaseLockup struct with branchService. Added and refined functions for handling tokens and rewards.
x/accounts/defaults/lockup/periodic_locking_account.go, continuous_locking_account.go, delayed_locking_account.go, permanent_locking_account.go Adjusted token handling logic, removed and modified methods, enhanced testing scenarios.
x/accounts/proto/cosmos/accounts/defaults/lockup/tx.proto, x/accounts/defaults/lockup_test.go, x/accounts/defaults/lockup/utils_test.go Added MsgWithdrawReward, updated error handling in tests, and modified utility functions for new queries.
tests/e2e/accounts/lockup/... Enhanced end-to-end testing with new imports, functions, and updated testing scenarios focusing on account queries and token handling.
x/accounts/defaults/lockup/sonar-project.properties, .github/workflows/test.yml Updated Sonar project key and removed SonarCloud step from GitHub workflow.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between bfb1e18 and b44fb4e.
Files selected for processing (1)
  • .github/workflows/test.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/test.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sontrinh16 sontrinh16 marked this pull request as ready for review April 15, 2024 04:12
@sontrinh16 sontrinh16 requested a review from a team as a code owner April 15, 2024 04:12
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

api/cosmos/accounts/defaults/lockup/tx.pulsar.go Dismissed Show dismissed Hide dismissed
api/cosmos/accounts/defaults/lockup/tx.pulsar.go Dismissed Show dismissed Hide dismissed
Copy link
Member

@facundomedica facundomedica left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Comment on lines +44 to +47
{
Amount: sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(500))),
Length: time.Minute,
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in test data setup.

Consider using a loop to add multiple periods with the same settings to reduce redundancy and improve maintainability.

- {
-   Amount: sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(500))),
-   Length: time.Minute,
- },
+ for i := 0; i < 3; i++ {
+   periods = append(periods, types.Period{
+     Amount: sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(500))),
+     Length: time.Minute,
+   })
+ }

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
{
Amount: sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(500))),
Length: time.Minute,
},
for i := 0; i < 3; i++ {
periods = append(periods, types.Period{
Amount: sdk.NewCoins(sdk.NewCoin("stake", math.NewInt(500))),
Length: time.Minute,
})
}

@sontrinh16 sontrinh16 added this pull request to the merge queue Apr 29, 2024
Merged via the queue into main with commit cb50b4c Apr 29, 2024
63 checks passed
@sontrinh16 sontrinh16 deleted the son/lockup_cleanup branch April 29, 2024 08:36
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants